<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>MiXiM: SimpleConstMapping Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">MiXiM
   &#160;<span id="projectnumber">2.3</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('a00194.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">SimpleConstMapping Class Reference<div class="ingroups"><a class="el" href="a00519.html">mapping - classes representing mathematical mappings</a></div></div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="SimpleConstMapping" --><!-- doxytag: inherits="ConstMapping" -->
<p>Abstract subclass of <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> which can be used as base for any <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> implementation with read access of constant complexity.  
 <a href="a00194.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00298_source.html">MappingBase.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SimpleConstMapping:</div>
<div class="dyncontent">
<div class="center"><img src="a01000.png" border="0" usemap="#SimpleConstMapping_inherit__map" alt="Inheritance graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SimpleConstMapping:</div>
<div class="dyncontent">
<div class="center"><img src="a01001.png" border="0" usemap="#SimpleConstMapping_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="a01002.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00059.html">ConstMappingIterator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a70d0d044f36428965b77233bbf4c698b">createConstIterator</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer of a new Iterator which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>.  <a href="#a70d0d044f36428965b77233bbf4c698b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00059.html">ConstMappingIterator</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#ab0dfc0c3ba9ba222176b29d88a4e6578">createConstIterator</a> (const <a class="el" href="a00013.html">Argument</a> &amp;pos) const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a pointer of a new Iterator which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. The iterator starts at the passed position.  <a href="#ab0dfc0c3ba9ba222176b29d88a4e6578"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0794f7d9a8afe0dc17232211eb451302"></a><!-- doxytag: member="SimpleConstMapping::SimpleConstMapping" ref="a0794f7d9a8afe0dc17232211eb451302" args="(const DimensionSet &amp;dims)" -->
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a0794f7d9a8afe0dc17232211eb451302">SimpleConstMapping</a> (const <a class="el" href="a00086.html">DimensionSet</a> &amp;dims)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a not yet iterateable SimpleConstmapping with the passed <a class="el" href="a00086.html" title="Represents a set of dimensions which is used to define over which dimensions a mapping is defined (th...">DimensionSet</a> as domain. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a964085459e9772b74341f7386cd665e3"></a><!-- doxytag: member="SimpleConstMapping::SimpleConstMapping" ref="a964085459e9772b74341f7386cd665e3" args="(const SimpleConstMapping &amp;o)" -->
&#160;</td><td class="memItemRight" valign="bottom"><b>SimpleConstMapping</b> (const <a class="el" href="a00194.html">SimpleConstMapping</a> &amp;o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00194.html">SimpleConstMapping</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#aa49498d175e63415d1b16656ffe2e28b">operator=</a> (const <a class="el" href="a00194.html">SimpleConstMapping</a> &amp;copy)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">SimpleConstMapping assignment operator.  <a href="#aa49498d175e63415d1b16656ffe2e28b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a77247e2c90cc1d33bcfc305e575cab2c">swap</a> (<a class="el" href="a00194.html">SimpleConstMapping</a> &amp;s)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Swaps data with another SimpleConstMapping.  <a href="#a77247e2c90cc1d33bcfc305e575cab2c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a2e89eb287b66b66bec570afa716a7e78">SimpleConstMapping</a> (const <a class="el" href="a00086.html">DimensionSet</a> &amp;dims, const <a class="el" href="a00013.html">Argument</a> &amp;key)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fully initializes this mapping with the passed position as key entry.  <a href="#a2e89eb287b66b66bec570afa716a7e78"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a8ad8dfd538dabda7d637819a2f34a1b5">SimpleConstMapping</a> (const <a class="el" href="a00086.html">DimensionSet</a> &amp;dims, const <a class="el" href="a00013.html">Argument</a> &amp;key1, const <a class="el" href="a00013.html">Argument</a> &amp;key2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fully initializes this mapping with the passed two positions as key entries.  <a href="#a8ad8dfd538dabda7d637819a2f34a1b5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#acd1a6f80289031ea0f5ccc6b29cae9d5">SimpleConstMapping</a> (const <a class="el" href="a00086.html">DimensionSet</a> &amp;dims, const <a class="el" href="a00013.html">Argument</a> &amp;min, const <a class="el" href="a00013.html">Argument</a> &amp;max, const <a class="el" href="a00013.html">Argument</a> &amp;interval)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Fully initializes this mapping with the key entries defined by the passed min, max and interval values.  <a href="#acd1a6f80289031ea0f5ccc6b29cae9d5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a17d3c5e8c98e7451a844d59c95c7272a">initializeArguments</a> (const <a class="el" href="a00013.html">Argument</a> &amp;key)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the key entry set with the passed position as entry.  <a href="#a17d3c5e8c98e7451a844d59c95c7272a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a8555ecac0cfcfdcc07d540a640975607">initializeArguments</a> (const <a class="el" href="a00013.html">Argument</a> &amp;key1, const <a class="el" href="a00013.html">Argument</a> &amp;key2)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the key entry set with the passed two positions as entries.  <a href="#a8555ecac0cfcfdcc07d540a640975607"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#aca948c360cd24e21a92c80bf5f53cf16">initializeArguments</a> (const <a class="el" href="a00013.html">Argument</a> &amp;min, const <a class="el" href="a00013.html">Argument</a> &amp;max, const <a class="el" href="a00013.html">Argument</a> &amp;interval)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the key entry set with the passed min, max and interval-Arguments.  <a href="#aca948c360cd24e21a92c80bf5f53cf16"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual argument_value_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#aeb10c744b8f4c6df092332b6228e209e">getValue</a> (const <a class="el" href="a00013.html">Argument</a> &amp;pos) const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the value of the mapping at the passed position.  <a href="#aeb10c744b8f4c6df092332b6228e209e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00058.html">ConstMapping</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a49da397ee4ea25a6bdcf7f08dc6e2ed5">constClone</a> () const =0</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a clone of this mapping.  <a href="#a49da397ee4ea25a6bdcf7f08dc6e2ed5"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a48a5d4281c2bf8eda6b0cd96fb67e9"></a><!-- doxytag: member="SimpleConstMapping::KeyEntrySet" ref="a4a48a5d4281c2bf8eda6b0cd96fb67e9" args="" -->
typedef std::set&lt; <a class="el" href="a00013.html">Argument</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a4a48a5d4281c2bf8eda6b0cd96fb67e9">KeyEntrySet</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Type for a set of Arguments defining key entries. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3804bf19eee40fe09c626b7ca9e0885e"></a><!-- doxytag: member="SimpleConstMapping::createKeyEntries" ref="a3804bf19eee40fe09c626b7ca9e0885e" args="(const Argument &amp;from, const Argument &amp;to, const Argument &amp;step, Argument &amp;pos)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a3804bf19eee40fe09c626b7ca9e0885e">createKeyEntries</a> (const <a class="el" href="a00013.html">Argument</a> &amp;from, const <a class="el" href="a00013.html">Argument</a> &amp;to, const <a class="el" href="a00013.html">Argument</a> &amp;step, <a class="el" href="a00013.html">Argument</a> &amp;pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility method to fill add range of key entries in the time dimension to the key entry set. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6f392c0904f66eb264c597980873367"></a><!-- doxytag: member="SimpleConstMapping::createKeyEntries" ref="aa6f392c0904f66eb264c597980873367" args="(const Argument &amp;from, const Argument &amp;to, const Argument &amp;step, DimensionSet::const_iterator curDim, Argument &amp;pos)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#aa6f392c0904f66eb264c597980873367">createKeyEntries</a> (const <a class="el" href="a00013.html">Argument</a> &amp;from, const <a class="el" href="a00013.html">Argument</a> &amp;to, const <a class="el" href="a00013.html">Argument</a> &amp;step, DimensionSet::const_iterator curDim, <a class="el" href="a00013.html">Argument</a> &amp;pos)</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Utility method to fill add range of key entries in the passed dimension (and recursively its sub dimensions) to the key entry set. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a022d4ae04338d12fad79f4e2f9b1f7af"></a><!-- doxytag: member="SimpleConstMapping::keyEntries" ref="a022d4ae04338d12fad79f4e2f9b1f7af" args="" -->
<a class="el" href="a00194.html#a4a48a5d4281c2bf8eda6b0cd96fb67e9">KeyEntrySet</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af">keyEntries</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A set of Arguments defining the "points of interest" an iterator should iterate over. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Abstract subclass of <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> which can be used as base for any <a class="el" href="a00058.html" title="Represents a not changeable mapping (mathematical function) from domain with at least the time to a A...">ConstMapping</a> implementation with read access of constant complexity. </p>
<p>Any subclass only has to implement the "getValue()" and the "clone()"-method.</p>
<p>The subclass has to define the "points of interest" an iterator should iterate over. This should be done either at construction time or later by calling the "initializeArguments()"-method.</p>
<p>The <a class="el" href="a00194.html" title="Abstract subclass of ConstMapping which can be used as base for any ConstMapping implementation with ...">SimpleConstMapping</a> class provides Iterator creation by using the <a class="el" href="a00195.html" title="A fully working ConstIterator-implementation usable with almost every ConstMapping.">SimpleConstMappingIterator</a> which assumes that the underlying ConstMappings <a class="el" href="a00194.html#aeb10c744b8f4c6df092332b6228e209e" title="Returns the value of the mapping at the passed position.">getValue()</a>-method is fast enough to be called on every iteration step (which means constant complexity).</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Karl Wessel </dd></dl>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2e89eb287b66b66bec570afa716a7e78"></a><!-- doxytag: member="SimpleConstMapping::SimpleConstMapping" ref="a2e89eb287b66b66bec570afa716a7e78" args="(const DimensionSet &amp;dims, const Argument &amp;key)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SimpleConstMapping::SimpleConstMapping </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00086.html">DimensionSet</a> &amp;&#160;</td>
          <td class="paramname"><em>dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fully initializes this mapping with the passed position as key entry. </p>
<p>A <a class="el" href="a00194.html" title="Abstract subclass of ConstMapping which can be used as base for any ConstMapping implementation with ...">SimpleConstMapping</a> initialized by this constructor is able to return a valid ConstIterator. </p>
<div class="fragment"><pre class="fragment">                                         :
    <a class="code" href="a00058.html#a7cfc5de32a0d03abfeb9b77fdcf7a413" title="Initializes the ConstMapping with a the time dimension as domain.">ConstMapping</a>(dims), <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>() {

    <a class="code" href="a00194.html#a17d3c5e8c98e7451a844d59c95c7272a" title="Initializes the key entry set with the passed position as entry.">initializeArguments</a>(key);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="a8ad8dfd538dabda7d637819a2f34a1b5"></a><!-- doxytag: member="SimpleConstMapping::SimpleConstMapping" ref="a8ad8dfd538dabda7d637819a2f34a1b5" args="(const DimensionSet &amp;dims, const Argument &amp;key1, const Argument &amp;key2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SimpleConstMapping::SimpleConstMapping </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00086.html">DimensionSet</a> &amp;&#160;</td>
          <td class="paramname"><em>dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fully initializes this mapping with the passed two positions as key entries. </p>
<p>A <a class="el" href="a00194.html" title="Abstract subclass of ConstMapping which can be used as base for any ConstMapping implementation with ...">SimpleConstMapping</a> initialized by this constructor is able to return a valid ConstIterator. </p>
<div class="fragment"><pre class="fragment">                                                                :
    <a class="code" href="a00058.html#a7cfc5de32a0d03abfeb9b77fdcf7a413" title="Initializes the ConstMapping with a the time dimension as domain.">ConstMapping</a>(dims), <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>() {

    <a class="code" href="a00194.html#a17d3c5e8c98e7451a844d59c95c7272a" title="Initializes the key entry set with the passed position as entry.">initializeArguments</a>(key1, key2);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="acd1a6f80289031ea0f5ccc6b29cae9d5"></a><!-- doxytag: member="SimpleConstMapping::SimpleConstMapping" ref="acd1a6f80289031ea0f5ccc6b29cae9d5" args="(const DimensionSet &amp;dims, const Argument &amp;min, const Argument &amp;max, const Argument &amp;interval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SimpleConstMapping::SimpleConstMapping </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00086.html">DimensionSet</a> &amp;&#160;</td>
          <td class="paramname"><em>dims</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>max</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Fully initializes this mapping with the key entries defined by the passed min, max and interval values. </p>
<p>A <a class="el" href="a00194.html" title="Abstract subclass of ConstMapping which can be used as base for any ConstMapping implementation with ...">SimpleConstMapping</a> initialized by this constructor is able to return a valid ConstIterator. </p>
<div class="fragment"><pre class="fragment">                                                                                :
    <a class="code" href="a00058.html#a7cfc5de32a0d03abfeb9b77fdcf7a413" title="Initializes the ConstMapping with a the time dimension as domain.">ConstMapping</a>(dims), <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>() {

    <a class="code" href="a00194.html#a17d3c5e8c98e7451a844d59c95c7272a" title="Initializes the key entry set with the passed position as entry.">initializeArguments</a>(min, max, interval);
  }
</pre></div>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a49da397ee4ea25a6bdcf7f08dc6e2ed5"></a><!-- doxytag: member="SimpleConstMapping::constClone" ref="a49da397ee4ea25a6bdcf7f08dc6e2ed5" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00058.html">ConstMapping</a>* SimpleConstMapping::constClone </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>creates a clone of this mapping. </p>
<p>This method has to be implemented by every subclass. </p>

<p>Implements <a class="el" href="a00058.html#a741e083fb18412a3d9cde7eac3dced10">ConstMapping</a>.</p>

<p>Implemented in <a class="el" href="a00055.html#a63f15a3fb6da788dbaaeb8b1ee5470f2">ConstantSimpleConstMapping</a>, <a class="el" href="a00115.html#ab8c347fa961711d3fd2c86b425cddc53">JakesFadingMapping</a>, <a class="el" href="a00198.html#a07a068298d3682405c07849bbcafac3e">SimplePathlossConstMapping</a>, and <a class="el" href="a00200.html#aea131c470ba71700264787a55b9d2d0e">SimpleTimeConstMapping</a>.</p>

</div>
</div>
<a class="anchor" id="a70d0d044f36428965b77233bbf4c698b"></a><!-- doxytag: member="SimpleConstMapping::createConstIterator" ref="a70d0d044f36428965b77233bbf4c698b" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00059.html">ConstMappingIterator</a>* SimpleConstMapping::createConstIterator </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns a pointer of a new Iterator which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. </p>
<p>This method asserts that the mapping had been fully initialized. </p>

<p>Implements <a class="el" href="a00058.html#a5ff3a15fe6d536fa7a26a3fe1ff1b274">ConstMapping</a>.</p>
<div class="fragment"><pre class="fragment">                                                            {
    <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="a00195.html" title="A fully working ConstIterator-implementation usable with almost every ConstMapping.">SimpleConstMappingIterator</a>(<span class="keyword">this</span>, &amp;<a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="ab0dfc0c3ba9ba222176b29d88a4e6578"></a><!-- doxytag: member="SimpleConstMapping::createConstIterator" ref="ab0dfc0c3ba9ba222176b29d88a4e6578" args="(const Argument &amp;pos) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00059.html">ConstMappingIterator</a>* SimpleConstMapping::createConstIterator </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns a pointer of a new Iterator which is able to iterate over the <a class="el" href="a00136.html" title="Represents a changeable mapping (mathematical function) from at least time to Argument::mapped_type.">Mapping</a>. The iterator starts at the passed position. </p>
<p>This method asserts that the mapping had been fully initialized. </p>

<p>Implements <a class="el" href="a00058.html#a951552e2e7f48717ed79d540af538d73">ConstMapping</a>.</p>
<div class="fragment"><pre class="fragment">                                                                               {
    <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="a00195.html" title="A fully working ConstIterator-implementation usable with almost every ConstMapping.">SimpleConstMappingIterator</a>(<span class="keyword">this</span>, &amp;<a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>, pos);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="aeb10c744b8f4c6df092332b6228e209e"></a><!-- doxytag: member="SimpleConstMapping::getValue" ref="aeb10c744b8f4c6df092332b6228e209e" args="(const Argument &amp;pos) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual argument_value_t SimpleConstMapping::getValue </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>pos</em></td><td>)</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the value of the mapping at the passed position. </p>
<p>This method has to be implemented by every subclass and should only have constant complexity. </p>

<p>Implements <a class="el" href="a00058.html#afabbd15bb8f50e45901f99633d0a47c9">ConstMapping</a>.</p>

<p>Implemented in <a class="el" href="a00055.html#a64ad8ca116f9a3f0ea575954f43a6706">ConstantSimpleConstMapping</a>, <a class="el" href="a00115.html#a23e8978d7aab4509f846ac6a8044de19">JakesFadingMapping</a>, <a class="el" href="a00198.html#aa263547a6e528cc1acf88fc496510e40">SimplePathlossConstMapping</a>, and <a class="el" href="a00200.html#aa7f481ebc2ec51c38a98af9595fb00cc">SimpleTimeConstMapping</a>.</p>

</div>
</div>
<a class="anchor" id="a17d3c5e8c98e7451a844d59c95c7272a"></a><!-- doxytag: member="SimpleConstMapping::initializeArguments" ref="a17d3c5e8c98e7451a844d59c95c7272a" args="(const Argument &amp;key)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SimpleConstMapping::initializeArguments </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the key entry set with the passed position as entry. </p>
<p>Convenience method for simple mappings. </p>

<p>Referenced by <a class="el" href="a00029.html#a42664d512b88bedf58b5d21adc180984">BasePhyLayer::getThermalNoise()</a>, and <a class="el" href="a00200.html#a97917a522331bafda509d61dd804ecaa">SimpleTimeConstMapping::SimpleTimeConstMapping()</a>.</p>
<div class="fragment"><pre class="fragment">                                               {
    <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.clear();
    <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.insert(key);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="a8555ecac0cfcfdcc07d540a640975607"></a><!-- doxytag: member="SimpleConstMapping::initializeArguments" ref="a8555ecac0cfcfdcc07d540a640975607" args="(const Argument &amp;key1, const Argument &amp;key2)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SimpleConstMapping::initializeArguments </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>key2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the key entry set with the passed two positions as entries. </p>
<p>Convenience method for simple mappings. </p>
<div class="fragment"><pre class="fragment">                                                                      {
    <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.clear();
    <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.insert(key1);
    <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.insert(key2);
  }
</pre></div>
</div>
</div>
<a class="anchor" id="aca948c360cd24e21a92c80bf5f53cf16"></a><!-- doxytag: member="SimpleConstMapping::initializeArguments" ref="aca948c360cd24e21a92c80bf5f53cf16" args="(const Argument &amp;min, const Argument &amp;max, const Argument &amp;interval)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SimpleConstMapping::initializeArguments </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>min</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>max</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="a00013.html">Argument</a> &amp;&#160;</td>
          <td class="paramname"><em>interval</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Initializes the key entry set with the passed min, max and interval-Arguments. </p>
<p>After a call to this method this <a class="el" href="a00194.html" title="Abstract subclass of ConstMapping which can be used as base for any ConstMapping implementation with ...">SimpleConstMapping</a> is able to return a valid ConstIterator. </p>

<p>References <a class="el" href="a00194.html#a3804bf19eee40fe09c626b7ca9e0885e">createKeyEntries()</a>, <a class="el" href="a00058.html#a009539b72014b7bed96402a5c244fca5">ConstMapping::dimensions</a>, and <a class="el" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af">keyEntries</a>.</p>
<div class="fragment"><pre class="fragment">                                                                       {
  <a class="code" href="a00194.html#a022d4ae04338d12fad79f4e2f9b1f7af" title="A set of Arguments defining the &quot;points of interest&quot; an iterator should iterate over.">keyEntries</a>.clear();
  DimensionSet::const_iterator dimIt = --(<a class="code" href="a00058.html#a009539b72014b7bed96402a5c244fca5" title="The dimensions of this mappings domain.">dimensions</a>.end());
  <a class="code" href="a00013.html" title="Defines an argument for a mapping.">Argument</a>                     pos   = min;

  <span class="keywordflow">if</span>(*dimIt == <a class="code" href="a00085.html#a16cb1f186dd3f48d33a4aebe948001d7" title="Shortcut to the time Dimension, same as &#39;Dimension(&quot;time&quot;)&#39;, but spares the parsing of a string...">Dimension::time</a>)
    <a class="code" href="a00194.html#a3804bf19eee40fe09c626b7ca9e0885e" title="Utility method to fill add range of key entries in the time dimension to the key entry set...">createKeyEntries</a>(min, max, interval, pos);
  <span class="keywordflow">else</span>
    <a class="code" href="a00194.html#a3804bf19eee40fe09c626b7ca9e0885e" title="Utility method to fill add range of key entries in the time dimension to the key entry set...">createKeyEntries</a>(min, max, interval, dimIt, pos);
}
</pre></div>
</div>
</div>
<a class="anchor" id="aa49498d175e63415d1b16656ffe2e28b"></a><!-- doxytag: member="SimpleConstMapping::operator=" ref="aa49498d175e63415d1b16656ffe2e28b" args="(const SimpleConstMapping &amp;copy)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00194.html">SimpleConstMapping</a>&amp; SimpleConstMapping::operator= </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00194.html">SimpleConstMapping</a> &amp;&#160;</td>
          <td class="paramname"><em>copy</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>SimpleConstMapping assignment operator. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">copy</td><td>A SimpleConstMapping of identical element and allocator types.</td></tr>
  </table>
  </dd>
</dl>
<p>All the elements of <em>copy</em> are copied. </p>

<p>References <a class="el" href="a00058.html#a28a66ff19a5046d773d6f0c49f12353f">ConstMapping::operator=()</a>.</p>
<div class="fragment"><pre class="fragment">                                                                {
    <a class="code" href="a00194.html#aa49498d175e63415d1b16656ffe2e28b" title="SimpleConstMapping assignment operator.">ConstMapping::operator=</a>(copy);
    <span class="keywordflow">return</span> *<span class="keyword">this</span>;
  }
</pre></div>
</div>
</div>
<a class="anchor" id="a77247e2c90cc1d33bcfc305e575cab2c"></a><!-- doxytag: member="SimpleConstMapping::swap" ref="a77247e2c90cc1d33bcfc305e575cab2c" args="(SimpleConstMapping &amp;s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SimpleConstMapping::swap </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00194.html">SimpleConstMapping</a> &amp;&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Swaps data with another SimpleConstMapping. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>A SimpleConstMapping of the same element and allocator types.</td></tr>
  </table>
  </dd>
</dl>
<p>This exchanges the elements between two SimpleConstMapping's in constant time. Note that the global std::swap() function is specialized such that std::swap(s1,s2) will feed to this function. </p>

<p>References <a class="el" href="a00058.html#a473df8fa0aa441ca1adb356b17b1f59f">ConstMapping::swap()</a>.</p>
<div class="fragment"><pre class="fragment">{ <a class="code" href="a00194.html#a77247e2c90cc1d33bcfc305e575cab2c" title="Swaps data with another SimpleConstMapping.">ConstMapping::swap</a>(s); <span class="comment">/* swap the base class members */</span> }
</pre></div>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/<a class="el" href="a00298_source.html">MappingBase.h</a></li>
<li>D:/Projects/MiXiM/extsrc/mixim/src/base/phyLayer/MappingBase.cc</li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="a00194.html">SimpleConstMapping</a>      </li>

    <li class="footer">Generated on Tue Mar 5 2013 21:26:33 for MiXiM by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li>
   </ul>
 </div>


</body>
</html>
